DescribeIpv6Addresses

Description

call DescribeIpv6Addresses interface to query IPv6 address list.

Request Method

POST

Request Path

/apsara/route/Vpc/DescribeIpv6Addresses

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
PageSize	BODY	integer	No	10	The number of rows per page during paging query, the maximum value is 50, and the default value is 10.
VSwitchId	BODY	string	No	vsw-123456nhmj****	switch ID where the IPv6 address is located.
version	BODY	string	No	2016-01-01	version of api
Name	BODY	string	No	test	the name of the IPv6 address.
AssociatedInstanceId	BODY	string	No	i-123456nhmj****	instance ID associated with IPv6 address.
VpcId	BODY	string	No	vpc-123456nhmj****	VPC ID where the IPv6 address is located.
PageNumber	BODY	integer	No	1	The page number of the list, the default value is 1.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
NetworkType	BODY	string	No	Public	communication capability type of IPv6 address, value: Private: private network communication type. public : public network communication type.
Ipv6AddressId	BODY	string	No	ipv6gw-hp33of4uz4k4knhmj****	ID of IPv6 address instance. You can enter up to 20 instance IDs for each call, separated by commas (,).
RegionId	BODY	string	Yes	cn-huhehaote	the region ID where the IPv6 address is located. You can obtain the region ID by calling the DescribeRegions interface.
Ipv6InternetBandwidthId	BODY	string	No	1	public network bandwidth of IPv6 address.
AssociatedInstanceType	BODY	string	No	EcsInstance	The instance type associated with the IPv6 address, value: EcsInstance(default): ECS of VPC type.
Ipv6Address	BODY	string	No	2408:xxxx:180:1701:94c7:bc38:3bfa:d2c	IPv6 address to query.

Return data

Name	Type	Sample value	Description
Status	string	Available	IPv6 address status, value: Pending: in configuration. Available: available.
PageSize	integer	10	The number of rows per page during paging query, the maximum value is 50, and the default value is 10.
RequestId	string	AA4486A8-B6AE-469E-AB09-820EF8ECFA2B	request ID.
VSwitchId	string	vsw-hp3123456nhmj****	ID of the switch where the IPv6 address is located.
Ipv6GatewayId	string	ipv6gw-hp38x2x0fz7nhmj****	the IPv6 gateway ID of the IPv6 address.
Ipv6Addresses		No sample value for this parameter.	IPv6 address details.
BusinessStatus	string	Normal	commercial status of exclusive bandwidth of IPv6 address, value: Normal: normal. FinacialLocked: overdue lock. SecurityLocked: security lock.
AllocationTime	string	2018-12-20T14:56:09Z	IPv6 address creation time.
Ipv6InternetBandwidth		No sample value for this parameter.	public network bandwidth information of IPv6 address.
TotalCount	integer	2	Number of entries in the list.
AssociatedInstanceId	string	i-hp325kt6307nhmj****	instance ID associated with IPv6 address.
VpcId	string	vpc-123456nhmj****	VPC ID where the IPv6 address is located.
PageNumber	integer	1	The page number of the list, the default value is 1.
NetworkType	string	Public	communication capability type of IPv6 address, value: Private: private network communication type. public : public network communication type.
Bandwidth	integer	2	Exclusive public network bandwidth of IPv6 address, unit Mbps.
Ipv6AddressId	string	ipv6-hp32vv2klzw4nhmj****	instance ID of IPv6 address.
Ipv6InternetBandwidthId	string	ipv6bw-hp3b35oq1fj5nhmj****	public network bandwidth ID.
AssociatedInstanceType	string	EcsInstance	the instance type associated with the IPv6 address.
Ipv6Address	string	2408:xxxx:0:2900:2901:3c61:9ff0:xxxx	IPv6 address.
Ipv6AddressName	string	test	the instance name of the IPv6 address.

Example

Successful Response example

{
 "Status":"Available",
 "PageSize":"10",
 "RequestId":"AA4486A8-B6AE-469E-AB09-820EF8ECFA2B",
 "VSwitchId":"vsw-hp3123456nhmj****",
 "Ipv6GatewayId":"ipv6gw-hp38x2x0fz7nhmj****",
 "Ipv6Addresses":"",
 "BusinessStatus":"Normal",
 "AllocationTime":"2018-12-20T14:56:09Z",
 "Ipv6InternetBandwidth":"",
 "TotalCount":"2",
 "AssociatedInstanceId":"i-hp325kt6307nhmj****",
 "VpcId":"vpc-123456nhmj****",
 "PageNumber":"1",
 "NetworkType":"Public",
 "Bandwidth":"2",
 "Ipv6AddressId":"ipv6-hp32vv2klzw4nhmj****",
 "Ipv6InternetBandwidthId":"ipv6bw-hp3b35oq1fj5nhmj****",
 "AssociatedInstanceType":"EcsInstance",
 "Ipv6Address":"2408:xxxx:0:2900:2901:3c61:9ff0:xxxx",
 "Ipv6AddressName":"test"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}